K-line data

Description

Returns K-line (candlestick) data for a specified token (USDT pairs only) and time range, up to 1000 bars.

Use cases:

• Query K-lines for different time window types
• Combine price candles with timing decisions

Update frequency: Real-time per bucketType

Endpoint

• Method: POST
• Path: /open/v1/trade/kline/getTradeKLineList

Credits

• Cost: 2

Prerequisites

Obtain vsTokenId

Condition	Description	How to obtain
vsTokenId available	Use cached vsTokenId; no repeat lookup	Auto-extracted from context
vsTokenId missing	Call POST /vs-token/list	Prerequisite API call

Request parameters

Parameters are sent as JSON in the request body.

Field	Type	Required	Description
vsTokenId	long	Yes	Token ID
bucketType	string	Yes	K-line time window type
startTime	long	No	Start time (ms timestamp)
endTime	long	Yes	End time (ms timestamp)
size	integer	No	Number of bars; default 360, max 1000

Enum reference

bucketType — K-line time window

Value	Meaning
5m	5 minutes
15m	15 minutes
30m	30 minutes
1h	1 hour
4h	4 hours
1d	1 day
1w	1 week

Response fields

Structure of fields inside the data object:

Field	Type	Serialized	Description
vsTokenId	long	string	Token ID
symbol	string	string	Token symbol
name	string	string	Token name
klineType	string	string	K-line type
klineData	array	array	K-line bars
time	long	long	Time (ms timestamp)
open	number	string	Open
close	number	string	Close
high	number	string	High
low	number	string	Low
volume	number	string	Volume
amount	number	string	Turnover (USD)

Field semantics

Field	Meaning	Tip
volume	Trading volume	Activity in the bar period
amount	Turnover	USD notional; with volume gives average price

Example

{
    "vsTokenId": 1,               // Token id
    "bucketType": "5m",            // K-line time window type
    "endTime": 1773478632535,      // End time
    "size": 20                     // Bar count; default 360, max 1000
}

cURL (Linux/macOS)

curl --location --request POST 'http://${host}/api/open/v1/trade/kline/getTradeKLineList' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: xxxxx' \
--header 'X-TIMESTAMP: xxxxx' \
--header 'X-SIGN: xxxxx' \
--header 'Accept: */*' \
--data-raw '{
    "vsTokenId": 1,
    "bucketType": "5m",
    "endTime": 1773478632535,
    "size": 20
}'

cURL (Windows CMD)

curl --location --request POST "http://${host}/api/open/v1/trade/kline/getTradeKLineList" ^
--header "Content-Type: application/json" ^
--header "X-API-KEY: xxxxx" ^
--header "X-TIMESTAMP: xxxxx" ^
--header "X-SIGN: xxxxx" ^
--header "Accept: */*" ^
--data-raw "{    \"vsTokenId\": 1,    \"bucketType\": \"5m\",    \"endTime\": 1773478632535,    \"size\": 20}"

Success response example

{
    "code": 200,
    "message": "success",
    "data": {
        "vsTokenId": "1",                       // Token ID
        "symbol": "BTC",                         // Token symbol
        "name": "Bitcoin",                       // Token name
        "klineType": "01",                       // K-line type
        "klineData": [
            {
                "time": 1773478200000,            // Time
                "open": "70544.92",                // Open
                "close": "70594.48",               // Close
                "high": "70594.49",                // High
                "low": "70536.58",                 // Low
                "volume": "20.543779999999995",    // Volume
                "amount": "1449509.9399093997"     // Turnover (USD)
            },
            {
                "time": 1773477900000,
                "open": "70562.01",
                "close": "70544.92",
                "high": "70586.21",
                "low": "70536.72",
                "volume": "57.95012",
                "amount": "4089095.6473876997"
            },
            {
                "time": 1773477600000,
                "open": "70612.38",
                "close": "70562",
                "high": "70613.76",
                "low": "70562",
                "volume": "14.238029999999998",
                "amount": "1004960.1104217"
            }
            // ... more rows omitted
        ]
    },
    "requestId": "xxx-xxx-xxx"
}